refactor(PeriphDrivers)!: Update WUT API naming schemes for MAX32655, MAX32657, MAX32665, MAX32690, MAX78000, and MAX78002. Offer WUT selection on MAX32690 #1291
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…election. Deprecating MXC_WUT_IntClear(void)
…in favor of MXC_WUT_ClearFlags for an updated naming scheme
github-actions
bot
added
MAX32655
|
/clang-format-run |
crsz20
commented
Dec 12, 2024
crsz20
commented
Dec 12, 2024
sihyung-maxim
requested changes
Dec 12, 2024
This comment was marked as resolved.
This comment was marked as resolved.
…, and Count(), marking them as deprecated on other devices
|
The PR description has been updated to account for the ME18 not having functions marked as deprecated. |
crsz20
added
Ready for review
|
Adding @EricB-ADI @kevin-gillespie so they could be aware of these changes. As Cristian mentioned, the breaking change is only with the ME18. |
sihyung-maxim
pushed a commit
to analogdevicesinc/hal_adi
that referenced
this pull request
Dec 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The MAX32690's WUT functions perform operations using a single instance of the wake-up timer. However, the max32690.h file shows that there are two instances. This can be confirmed in section 24.1 of the device User Guide.
This is a breaking change as the function prototypes and signatures have been modified to offer a
mxc_wut_regs_t *wutselection as an argument instead of defaulting to a single WUT instance.Deprecation
In favor of the
[action][verb]()naming scheme for functions, the following functions are being marked as deprecated and updated with a new name:MXC_WUT_IntClear()is being replaced byMXC_WUT_ClearFlags().MXC_WUT_IntStatus()is being replaced byMXC_WUT_GetFlags().MXC_WUT_Edge()is being replaced byMXC_WUT_WaitForEdge().MXC_WUT_Store()is being replaced byMXC_WUT_StoreCount().Note: Unlike the other impacted devices, the MAX32690 will not have old functions marked as deprecated. Instead, these will be updated to their new names immediately as part of the breaking change, due to additional function argument.
Checklist Before Requesting Review